CygNet FMS ActiveX Controls – ActiveX Properties

Important:

This topic has been updated to include additional functionality provided subsequent to the CygNet Software v9.5 release by "Required" FMS patches available in the 95_Patch_Composite.zip via the CygNet Software download site.

These Help documents assume installation of required patches.

Visit the Weatherford software support portal (login required), and access the CygNet Software Download Website to obtain and install required patch files and update your CygNet Measurement system to access the new features (from the support portal select CygNet Software > CygNet Software Download Site [login] > Software > SCADA and Measurement Products > 9.5 > Patches > 95_Patch_Composite.zip). See CygNet Software Downloads for additional access information.

The CygNet FMS ActiveX controls have an additional set of properties that are listed on the ActiveX page of the Property Sheet seen in CygNet Studio/Vision screens. These properties are listed in the comprehensive properties table below, and also in Properties, Methods, and Events topics specific to each ActiveX control.

The Comprehensive table contains a comprehensive listing of all the CygNet FMS ActiveX control properties.

The Control-Specific list contains links to topics containing tables of the properties, events, and methods specific to each ActiveX control.

See also CxHmiFms in the Scripting section for additional details about scripting properties specific to each FMS control object.

CygNet FMS ActiveX Control Properties: Comprehensive

ActiveX properties for CygNet FMS controls are listed in the table below.

Property Description Default Value
(OCXProperties) Many of the ActiveX control properties can also be set in the CygNet FMS Control Properties dialog box, which is accessed via each control's CygNet Studio property sheet. On the Property Sheet, double-click (OCXProperties) or click ... to access the CygNet FMS * Control Properties dialog box.  
AlarmRecSourceFilter Specifies the source filter for the alarm record in the FMS Alarm control

Options are as follows.

  • 8 - Event_Alarms
  • 10 - User_Alarms
  • 255 - Any_Alarms
 255 - Any_Alarms
Appearance Specifies whether the control will have a 3D effect or a flat appearance

Options are as follows.

  • 0 - Flat
  • 1 - 3D
 0 - Flat
AttributeDisplaySettingsXml Specifies the XML string that contains the accumulated display settings for the FMS Dashboard control

Use the OCX Properties dialog box (Dashboard tab > Display Properties) to define.

See Configuring Dashboard Display Properties for more information.

  
BeginDate Specifies the start date for the control

Acceptable values can be in one of the following forms.

  • Absolute date - for example: 1/31/2021
  • Relative date - for example: T (today), T-14 (14 days prior to today), or T+1 (one day following today)

See Selecting Date and Time for more information.

 T-7
BorderStyle Specifies the border style of the control’s boundary

Options are as follows.

  • 0 — None
  • 1 — Fixed Single
 0 — None
ButtonText Specifies the text on the status bar button in the FMS Node Chooser control

Allowable characters (maximum of 20) are A-Z, a-z, 0-9, . (period), #, $, &, (, ), +, -, \, /, :, <, >, =, @, [, ], ^, {, }, _ (underscore), !, ~ (tilde). Spaces are acceptable, when they are not leading or trailing.

 Set as Session Node
ChooserAllowMultiSelect

AllowMultiSelect (for Node Chooser control)

 Specifies whether to allow multiple selection of Nodes in the control's Chooser list

Options are as follows.

  • 0 - No
  • 1 - Yes

Use the OCX Properties dialog box (General page) to define.

 1 - Yes
ChooserFilterString

FilterString (for Node Chooser control)

 Specifies a partial string of known Node names to populate the Filter text box in the control's Chooser

Wildcard values * (multiple character) and ? (single character) are supported.

Use the OCX Properties to access the Control Properties dialog box (General page) to define.

 * (multiple character wildcard) - all
ChooserFilterType

FilterType (for Node Chooser control)

 Specifies the filter type for the filter string in the control's Chooser

Options are as follows.

  • 0 - Name
  • 1 - Description
  • 2 - ID
 0 - Name
ChooserGroupSelection

GroupSelection (for Node Chooser control)

 Specifies the desired Node group to display in the control's Chooser

Options are populated according to configured groups of the following types.

  • All Nodes
  • General
  • Station
  • By Category

Use the OCX Properties dialog box (General page) to define.

 Depends on the groups configured in your system
ChooserNodeCategorySelection

NodeCategorySelection (for Node Chooser control)

 Specifies the desired Node category to display in the control's Chooser

Options are a subset of the following possibilities, as applicable to the selected control. Variants are noted in parentheses.

  • 1 - Node_Category1_Device (Dashboard, Jobs, Report)
  • 1 - Node_Category2_Device (History Graph, History Grid)
  • 1 - Node_Category3_Device (Exceptions)
  • 1 - Node_Category4_Device (Close Period)
  • 1 - Node_Category5_Device (Raw Device Data)
  • 2 - Node_Category1_Group (Dashboard, Jobs, Report)
  • 2 - Node_Category3_Group (Exceptions)
  • 2 - Node_Category4_Group (Close Period)
  • 3 - Node_Category1_Station (Dashboard, Jobs, Report)
  • 3 – Node_Category2_Station (History Graph, History Grid)
  • 3 - Node_Category3_Station (Exceptions)
  • 3 - Node_Category4_Station (Close Period)
  • 6 - Node_Category1_Any (Dashboard, Jobs, Report)
  • 6 - Node_Category3_Any (Exceptions)
  • 8 - Node_Category1_Gas_Device (Dashboard, Jobs, Report)
  • 8 – Node_Category2_Gas_Device (History Graph, History Grid)
  • 8 - Node_Category3_Gas_Device (Exceptions)
  • 8 - Node_Category4_Gas_Device (Close Period)
  • 8 - Node_Category5_Gas_Device (Raw Device Data)
  • 9 - Node_Category1_Liquid_Device (Dashboard, Jobs, Report)
  • 9 – Node_Category2_Liquid_Device (History Graph, History Grid)
  • 9 - Node_Category3_Liquid_Device (Exceptions)
  • 9 - Node_Category4_Liquid_Device (Close Period)
  • 9 - Node_Category5_Liquid_Device (Raw Device Data)
  • 13 - Node_Category1_Accessory (Jobs, Report)
  • 13 - Node_Category3_Accessory (Exceptions)
 Depends on control
ChooserNodeCategoryVisible

NodeCategoryVisible (for Node Chooser control)

 Specifies whether to show the Node Category selector in the control's Chooser

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
ChooserPrimarySortColumn

PrimarySortColumn (for Node Chooser control)

 Specifies the primary sort column for the columns in the control's Chooser

Options are as follows.

  • 0 - Type ascending
  • 2 - Name ascending
  • 3 - Description ascending
  • 4 - Type descending
  • 5 - Name descending
  • 6 - Description descending
 2 - Name
ChooserSiteServiceSelection

SiteServiceSelection (for Node Chooser control)

 Specifies the value of the FMS [SiteService] in the control's Chooser

Use the OCX Properties dialog box (General page) to define.

  
ChooserSiteServiceVisible

SiteServiceVisible (for Node Chooser control)

 Specifies whether to show the FMS service selector in the control's Chooser

Options are as follows.

  • 0 - No
  • 1 - Yes

Use the OCX Properties dialog box (General page) to define.

 1 - Yes
CmdDefinitionXml Specifies the XML string that contains the accumulated configuration settings for the FMS command definition for the control

Use the OCX Properties dialog box (Commands page) to define.

See FMS Commands for more information.

  
ColorExceptions When a ColorGrid option other than "0 - None" is selected, specifies whether or not to show records with exceptions according to the selected color option in the FMS History Grid control

Options are as follows.

  • 0 - No
  • 1 - Yes
 0 - No
ColorGrid Specifies the color options for selected data display in the History Grid control

Options are as follows.

  • 0 - None
  • 1 - Row background
  • 2 - Row text
  • 3 - Date/Time background
  • 4 - Date/Time text

See Using the History Grid Control for more information.

 0 - None
ColorMode Returns/sets how colors are applied on the FMS History Graph, whether to individual Nodes or based on acceptability (data quality) level

Options are as follows.

  • 0 - ColorModeSingleNode
  • 1 - ColorModeAcceptability
 0 - Single Node
ColorXml Specifies the XML string that contains the accumulated color settings for the FMS History Graph control

Use the OCX Properties dialog box (Colors page) to define.

  
ColumnsXml

Columns (for Balance control)

 Specifies the XML string that describes the columns to display in the control

Use the OCXProperties dialog box (<control> tab, then Columns) to define.

  
ConfigRecSourceFilter Specifies the source for Node configuration data from the drop-down menu on the FMS Configuration control's Options pane

Options are as follows.

  • 1 - Device
  • 2 - Import
  • 3 - File
  • 8 - Event
  • 9 - System
  • 10 - Manual
  • 11 - LinkedGQ
  • 14 - UserFile
  • 255 - Any

Use the OCX Properties dialog box (Configuration page) to define.

  
CustomColumnsUpdateInterval Specifies the update interval, in number of seconds, for the custom data columns, as configured in the Admin Options, if displayed in the FMS Dashboard control

See Using the Dashboard Control for more information.

 Persists as set; initial default value is 60 seconds
DataMode Specifies the data mode for viewing summary data in the FMS Dashboard control

Options are as follows.

  • 1 - Device_Mode
  • 3 - Station_Mode
 1 - Device_Mode
DataQualityColorXml Specifies the XML string that contains the accumulated color settings for the FMS Balance control

Use the OCX Properties dialog box (Data quality color button on the Balance page) to define.

  
DataView Specifies the type of data view for display in the FMS Configuration control

Options are as follows.

  • 0 - Data_View_Config
  • 1 - Data_View_Gas_Analysis
 0 - Data_View_Config
DateFormat Specifies the date/time format for the data displayed in the control

Options are as follows.

  • 0 - Device_Time
  • 1 - Contract_Time
  • 2 - Local_Time
 0 - Device_Time
DateTimeDisplayMode Specifies the date display convention for the control

Options are as follows.

  • 0 - LeadingTime
  • 1 - TrailingTime
 0 - LeadingTime
DecimalPrecision Specifies the decimal precision for data values displayed in the control

Acceptable values include 0 - 10 decimal places.

 7
DisplayMode Specifies the data view to display in the FMS Raw Data control

Options are as follows.

  • 1 - Alarm Entry
  • 11 - Config Log Raw
  • 20 - Event Entry
  • 25 - Metering Raw
  • 27 - Gas Quality Raw
 25 - Metering Raw
EndDate Specifies the end date for the control

Acceptable values can be in one of the following forms.

  • Absolute date - for example: 1/31/2021
  • Relative date - for example: T (today), T-14 (14 days prior to today), or T+1 (one day following today)

See Selecting Date and Time for more information.

 T
FilterConfigXml Specifies the XML string that contains the accumulated filter settings for the Alarm, Configuration, Dashboard, or Exceptions control. Use the "Filter" or "Log source" field on the corresponding ActiveX control property page to configure the filter settings

See the usage topic and properties list for the selected control for more information about filter selection options.

  
Font Accesses the MS Font dialog box, allowing specification of the text in the control. Click ... to access the Font dialog box to make font selections including type, style, size, and script options MS Shell Dlg
FontSize Specifies the font size of the text in the History Graph control

Options are as follows.

  • 0 - Large
  • 1 - Medium
  • 2 - Small
 1 - Medium
GridGroupsXml Returns/sets the XML specifying the group hierarchy that will appear on the FMS Exceptions control 

Another way to configure this property is to use the Control Properties dialog box (from the Property Sheet ActiveX page, click OCXProperties, then the Exceptions tab, and use the Grid groups browser) on the Exceptions page.

  
HeightOverride Specifies the height, in pixels, of the Value Table in the CygNet FMS History Graph control, if the UseHeightOverride value is set to 1 - Yes.  
HighlightExceptionCells In the CygNet FMS History Grid control, when a ColorGrid option other than "0 - None" is selected, specifies whether or not to highlight record cells that contain data triggering exceptions

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use OCXProperties to access the Control Properties dialog box > Grid page and select/clear the Highlight cells causing exceptions check box to define.

 1 - Yes
IsEditing Returns whether or not the user is currently editing data in the editable FMS control (Alarm, Configuration, or History Grid)  
JobTypeFilterView Specifies the type of jobs to display in the FMS Jobs control

Type the name of a job type into the text box to define the filter view desired.

Options are as follows.

  • <Any>
  • Auto-calibration
  • Calibration
  • Gas Sample
  • [User-supplied value options]

Note: Job types are configured in CygNet Dispatch or in FMS Explorer via the Extended Command Options on the Job Schedule Configuration page.

 <Any>
MaxDataQuality When a ColorGrid option other than "0 - None" is selected, specifies the maximum data quality value below which records will be shown in color in the FMS History Grid control

Color will be applied to records in the control with lower data quality than this selected value, according to the color mode value defined by the ColorGrid property.

Possible values for this property are as configured in your system, via the Admin menu. See Configuring Data Quality Settings for more information.

None
MaxRecords Specifies the maximum number of exceptions records to be returned in the control 100
MeterStationView For a Node that is a station meter (a Gas Meter Node set to also function as a station), specifies the station meter view to be displayed in the FMS History Grid or History Graph control

Options are as follows.

  • 8 - Gas_Devices_Mode
  • 3 - Stations_Mode
 8 - Gas_Devices_Mode
NodeOverride If Use Session Node is not selected, specifies the Node name against which to run the report from the Reports control  
PITDateTime Specifies the Point in Time to use for the data presented in the control

Acceptable values can be in one of the following forms.

  • Absolute Date/Time - for example: 1/31/2021 7:10:14 AM
  • Relative Date/Time - for example: y-1 m-2 d=15 H=5 M=30 S=0
  • Relative Day - an offset from the current day T, for example: T-10

See Using the Home Menu for more information about PIT mode.

See Selecting Point in Time for more information about time selection.

 T - Current
PrimarySortColumn Specifies the primary sort column for the columns in the control

Options are as follows.

  • 0 - Type ascending
  • 2 - Name ascending
  • 3 - Description ascending
  • 4 - Type descending
  • 5 - Name descending
  • 6 - Description descending

Use the OCX Properties dialog box (General page) to define.

 2 - Name
ProcessVarXml Returns/sets the XML specifying which process variables will be displayed in the FMS History Graph 

Another way to configure this property is to use the Control Properties dialog box (from the Property Sheet, ActiveX page, click OCXProperties, then on the Graph page use the Process Variables configuration list).

CygNet FMS Control Properties dialog box (from the Property Sheet, ActiveX page, click OCXProperties to access the Control Properties, then on the Exceptions page use the Grid groups browser).

  
RecordOrder Specifies the order for display of records in the Dashboard or History Grid controls

Options are as follows.

  • 0 - Oldest_First
  • 1 - Newest_First
 0 - Oldest_First
RecordSpan Specifies the record span to display in the FMS History Graph or FMS History Grid controls

Options are as follows.

  • 60 - Hourly
  • 1440 - Daily
  • 9999 - Native - Device data view only; not applicable to Station data view

Depends:

3 - Native for Device data view, 1 - Hourly for Station data view
ReportDefinitionXml Specifies the XML of the user-configured report definition for use by the Reports control <XML/>
ReportSelection Specifies the name of the report to run from the Reports control  
SessionNodeClickOption Specifies the Session Node selection behavior to use from the FMS Dashboard control

Options are as follows.

  • 0 - SingleClick
  • 1 - DoubleClick
 1 - DoubleClick
ShadingBackColor Specifies the background color for a selected cell. Use the pop-up to select a color

See Configuring Color for more information.

 RGB 255.250.205

(pale yellow)

ShadingForeColor Specifies the foreground color for a selected cell. Use the pop-up to select a color

See Configuring Color for more information.

 RGB 0.0.0 (black)
ShowApprovedJobs Specifies whether to show jobs with a status of "Approved" in the CygNet FMS Jobs control

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
ShowAutoResolved Specifies whether to show exceptions that have resolved automatically in the CygNet FMS Exceptions control

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
ShowBlockedJobs Specifies whether to show jobs with a status of "Blocked" in the CygNet FMS Jobs control

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
ShowChooserPane Specifies whether to show the Chooser pane in the CygNet FMS ActiveX control

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
ShowCompletedJobs Specifies whether to show jobs with a status of "Completed" in the CygNet FMS Jobs control

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
ShowConfigLogRecords Specifies whether to show configuration log records (that caused the exception) in the CygNet FMS Exceptions control

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
ShowCustomColumns Specifies whether to show custom columns, as configured in the Admin Options (Custom Dashboard Columns page), in the CygNet FMS Dashboard control

Options are as follows.

  • 0 - No
  • 1 - Yes
 0 - No
ShowExceptionCount Specifies whether to show the total number of exceptions for the selected Node in the CygNet FMS Dashboard control

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
ShowGasDeviceRecords Specifies whether to show gas device records (that caused the exception) in the CygNet FMS Exceptions control

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
ShowGasStationRecords Specifies whether to show gas station records (that caused the exception) in the CygNet FMS Exceptions control

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
ShowHourly In the CygNet FMS Balance control, specifies whether to show hourly records in addition to daily and monthly rollups in the control

Options are as follows.

  • 0 - No
  • 1 - Yes

Alternatively, use OCXProperties to access the Control Properties dialog box > Balance page, and select/clear the Show daily and monthly rollups only check box to define: selected means hourly records will not be shown (ShowHourly = 0 - No); cleared means hourly records will be shown (ShowHourly = 1 - Yes).

 1 - Yes
ShowIgnored Specifies whether to show ignored exceptions in the CygNet FMS Exceptions control

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
ShowLegend Specifies whether to show the color-coded device legend at the top of the CygNet FMS Hisory Graph

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
ShowManuallyResolved Specifies whether to show exceptions that have been resolved manually in the CygNet FMS Exceptions control

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
ShowMissingDataJobs Specifies whether to show jobs with a status of "Missing Data" in the CygNet FMS Jobs control

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
ShowNodeDescription Specifies whether to show the description of the selected Node in the CygNet FMS Dashboard control

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
ShowNodePriority Specifies whether to show the Node priority of the selected Node in the CygNet FMS Dashboard control

Options are as follows.

  • 0 - No
  • 1 - Yes
 0 - No
ShowOpen Specifies whether to show open exceptions in the CygNet FMS Exceptions control

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
ShowOpenJobs Specifies whether to show jobs with a status of "Open" in the CygNet FMS Jobs control

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
ShowOptionsPane Specifies whether to show the Options pane in the CygNet FMS ActiveX control

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
ShowPendingApprovalJobs Specifies whether to show jobs with a status of "Pending Approval" in the CygNet FMS Jobs control

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
ShowPercentMissing Specifies whether to show the percentage of missing data in the selected Node data row(s) in the CygNet FMS Dashboard control

"Missing data" means records with a collection status of anything other than Good or Partial.

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
ShowReviewJobs Specifies whether to show jobs with a status of "Review" in the CygNet FMS Jobs control

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
ShowShading Specifies whether to show color shading in the control's cell

Options are as follows.

  • 0 - None
  • 1 - Foreground
  • 2 - Background
  • 3 - Both
 3 - Both
ShowUnits Specifies whether to show units in the control

Options are as follows.

  • 0 - No
  • 1 - Yes
 Depends on control
ShowUseFilterButton Specifies whether to show the Use filter button in the Dashboard control

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
ShowVerifiedJobs Specifies whether to show jobs with a status of "Verified" in the CygNet FMS Jobs control

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
ShowWaitingForEventsJobs Specifies whether to show jobs with a status of "Waiting for Events" in the CygNet FMS Jobs control

Options are as follows.

  • 0 - No
  • 1 - Yes
 1 - Yes
SiteService Specifies the value of the FMS [SiteService]  
UnitSet Specifies the system unit set definition to use for the data presented in the control

See Configuring Unit Set Definitions for more information.

 <Default>
UseFilterConfig Specifies whether or not to use the configured filter in the FMS Alarm, Configuration, Dashboard, or Exceptions controls

Options are as follows.

  • 0 - No
  • 1 - Yes
 Depends on control
UseHeightOverride Specifies whether to use the configured HeightOverride property for the height, in pixels, of the Value Table in the CygNet FMS History Graph control

Options are as follows.

  • 0 - No
  • 1 - Yes
 0 - No
UsePIT Specifies whether to use the configured Point in Time for the data presented in the control

Options are as follows.

  • 0 - No
  • 1 - Yes
 0 - No
UseSessionNode Specifies whether to use the Session Node for the data presented in the control object

Options are as follows.

  • 0 - No
  • 1 - Yes
 0 - No
UseSessionOptions Specifies whether to use the Session options for the data presented in the control object

Options are as follows.

  • 0 - No
  • 1 - Yes
 0 - No
VisibleAttribute Specifies the data view option selected from the context menu in the CygNet FMS Dashboard control, depending on the DataMode selected

See Data view in the Using the Dashboard Control topic for more information about available data view options.

  

Back to top

CygNet ActiveX Control Properties: Control-Specific

See one of the following Properties, Methods, and Events topics for a listing of the properties, events, and methods applicable to a specific CygNet FMS ActiveX control.

Back to top